/*
 * jngc, Java utility classes by Nicholas Coltharp
 * Copyright (C) 2010 Nicholas Coltharp <ngc1@rice.edu>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package edu.rice.ngc1.util.time;

/**
 * This interface represent an object that keeps track of time. This
 * allows applications that would normally make calls to
 * {@link System#currentTimeMillis()} or {@link System#nanoTime()} to
 * instead make their calls to a pluggable interface, which improves
 * the capacity for unit testing.
 */
public interface TimeSource {

    /**
     * Gets the current time, in milliseconds.
     * 
     * @return the current time, in milliseconds
     */
    public long currentTimeMillis();

    /**
     * Gets the current time, in nanoseconds.
     * 
     * @return the current time, in nanoseconds
     */
    public long nanoTime();
}
